Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: annotations #974

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: annotations #974

wants to merge 1 commit into from
+180 −107

Conversation

eaudetcobello
Copy link
Contributor

@eaudetcobello eaudetcobello commented Jan 16, 2025 •
edited
Loading

  • Moves calico annotations to moonray docs
  • Removes cilium annotations from moonray docs
  • Adds warning about v1alpha annotations

@eaudetcobello eaudetcobello requested a review from a team as a code owner January 16, 2025 19:11
nhennigan
nhennigan approved these changes Jan 16, 2025
View reviewed changes
Copy link
Contributor

@nhennigan nhennigan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. You can merge or wait for another engineers review. Up to you 😸

bschimke95
bschimke95 approved these changes Jan 17, 2025
View reviewed changes
Copy link
Contributor

@bschimke95 bschimke95 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, minor nit

docs/moonray/reference/annotations.md
k8sd/v1alpha/lifecycle/skip-stop-services-on-remove: true
```

Please refer to the [Kubernetes website] for more information on annnotations.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would remove that. Those are not annotations in the sense of Kubernetes (e.g. we do not "annotate" a resource).
I'd add a brief explanation in the first paragraph instead.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can there be an explanations page for what annotations are and why they are useful/needed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@addyess addyess addyess left review comments

@bschimke95 bschimke95 bschimke95 approved these changes

@nhennigan nhennigan nhennigan approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@eaudetcobello @addyess @nhennigan @bschimke95